<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Get column information from a result and return as an object</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.cubrid-fetch-field" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">cubrid_fetch_field</h1>
  <p class="verinfo">(PECL CUBRID &gt;= 8.3.1)</p><p class="refpurpose"><span class="refname">cubrid_fetch_field</span> &mdash; <span class="dc-title">Get column information from a result and return as an object</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.cubrid-fetch-field-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>cubrid_fetch_field</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$field_offset</code><span class="initializer"> = 0</span></span>
  ] ) : <span class="type">object</span></div>

  <p class="para rdfs-comment">
    This function returns an object with certain properties of the specific
    column. The properties of the object are:
  </p>
  <p class="para">
    <dl>

    
  <dt>
<code class="parameter">name</code></dt>

  <dd>
<p class="para">column name</p></dd>

   
   
  <dt>
<code class="parameter">table</code></dt>

  <dd>
<p class="para">name of the table that the column belongs to</p></dd>

   
   
  <dt>
<code class="parameter">def</code></dt>

  <dd>
<p class="para">default value of the column</p></dd>

   
   
  <dt>
<code class="parameter">max_length</code></dt>

  <dd>
<p class="para">maximum length of the column</p></dd>

   
   
  <dt>
<code class="parameter">not_null</code></dt>

  <dd>
<p class="para">1 if the column cannot be NULL</p></dd>

   
   
  <dt>
<code class="parameter">primary_key</code></dt>

  <dd>
<p class="para">1 if the column is a primary key</p></dd>

   
   
  <dt>
<code class="parameter">unique_key</code></dt>

  <dd>
<p class="para">1 if the column is an unique key</p></dd>

   
   
  <dt>
<code class="parameter">multiple_key</code></dt>

  <dd>
<p class="para">1 if the column is a non-unique key</p></dd>

   
   
  <dt>
<code class="parameter">numeric</code></dt>

  <dd>
<p class="para">1 if the column is numeric</p></dd>

   
   
  <dt>
<code class="parameter">blob</code></dt>

  <dd>
<p class="para">1 if the column is a BLOB</p></dd>

   
   
  <dt>
<code class="parameter">type</code></dt>

  <dd>
<p class="para">the type of the column</p></dd>

   
   
  <dt>
<code class="parameter">unsigned</code></dt>

  <dd>
<p class="para">1 if the column is unsigned</p></dd>

   
   
  <dt>
<code class="parameter">zerofill</code></dt>

  <dd>
<p class="para">1 if the column is zero-filled</p></dd>

   
  </dl>

  
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.cubrid-fetch-field-parameters">
 <h3 class="title">参数</h3>
 <p class="para">
  <dl>

    
    <dt>
<code class="parameter">result</code></dt>

    <dd>
<p class="para"><code class="parameter">result</code> comes from a call to <span class="function"><a href="cubrid_execute.html" class="function">cubrid_execute()</a></span></p></dd>

   
   
    <dt>
<code class="parameter">field_offset</code></dt>

    <dd>
<p class="para">
     The numerical field offset. If the field offset is not specified, the
     next field (that was not yet retrieved by this function) is retrieved.
     The <code class="parameter">field_offset</code> starts at 0.
    </p></dd>

   
  </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.cubrid-fetch-field-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
    Object with certain properties of the specific column, when process is successful.
  </p>
   <p class="para">
    <strong><code>FALSE</code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.cubrid-fetch-field-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-1162">
   <p><strong>Example #1 <span class="function"><strong>cubrid_fetch_field()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$conn&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">cubrid_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">33000</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"demodb"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$req&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"SELECT&nbsp;event_code,athlete_code,nation_code,game_date&nbsp;FROM&nbsp;game&nbsp;WHERE&nbsp;host_year=1988&nbsp;and&nbsp;event_code=20001;"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">cubrid_fetch_row</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">cubrid_field_seek</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$field&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">cubrid_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"\n---&nbsp;Field&nbsp;Properties&nbsp;---\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%s\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"name:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%s\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"table:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">table</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;\"%s\"\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"default&nbsp;value:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">def</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"max&nbsp;length:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">max_length</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"not&nbsp;null:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">not_null</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"primary&nbsp;key:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">primary_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"unique&nbsp;key:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unique_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"multiple&nbsp;key:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">multiple_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"numeric:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">numeric</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"blob:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">blob</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%s\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"type:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">type</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"unsigned:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unsigned</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s&nbsp;%d\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"zerofill:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">zerofill</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">cubrid_close_request</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">cubrid_disconnect</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
   </div>

    <div class="example-contents"><p>以上例程会输出：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
array(4) {
  [0]=&gt;
  string(5) &quot;20001&quot;
  [1]=&gt;
  string(5) &quot;16681&quot;
  [2]=&gt;
  string(3) &quot;KOR&quot;
  [3]=&gt;
  string(9) &quot;1988-9-30&quot;
}

--- Field Properties ---
name:                          athlete_code
table:                         game
default value:                 &quot;&quot;
max length:                    0
not null:                      1
primary key:                   1
unique key:                    1
multiple key:                  0
numeric:                       1
blob:                          0
type:                          integer
unsigned:                      0
zerofill:                      0
</pre></div>
    </div>
  </div>
 </div>


</div></div></div></body></html>